<html>
<head>
<title>Reference Guide</title>
<link rel="stylesheet" type="text/css" href="../media/style.css">
</head>
<body>

<table border="0" cellspacing="0" cellpadding="0" height="48" width="100%">
  <tr>
    <td class="header_top">HTML_Progress</td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
  <tr>
    <td class="header_menu">
  		  [ <a href="../classtrees_HTML_Progress.html" class="menu">class tree: HTML_Progress</a> ]
		  [ <a href="../elementindex_HTML_Progress.html" class="menu">index: HTML_Progress</a> ]
		  [ <a href="../elementindex.html" class="menu">all elements</a> ]
    </td>
  </tr>
  <tr><td class="header_line"><img src="../media/empty.png" width="1" height="1" border="0" alt=""  /></td></tr>
</table>

<table width="100%" border="0" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td>
      <table cellpadding="10" cellspacing="0" width="100%" border="0"><tr><td valign="top">

<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="10%" align="left" valign="bottom"><a href=
"../HTML_Progress/tutorial_part2-monitor.pkg.html">Prev</a></td>
<td width="80%" align="center" valign="bottom"></td>
<td width="10%" align="right" valign="bottom"><a href=
"../HTML_Progress/tutorial_progress.apiversion.pkg.html">Next</a></td>
</tr>
</table>
<div><a name=""></a><div class="ref-title-box"><div class="ref-title">Reference Guide</div>
  <div class="ref-purpose">this reference describes every API in the HTML_Progress package</div></div>

 <h1 align="center">Table of Contents</h1>
<ul>

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#common-ref">Common Function Reference</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#error-ref">Error Handler Reference</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#observer-ref">Observer Pattern Reference</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#math-ref">Mathematical Reference</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#graphic-ref">Graphical Reference</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#model-ref">Data Model</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#constant-ref">Package HTML_Progress Constants</a><br />

<a href="../HTML_Progress/tutorial_part3-reference.pkg.html#monitor-ref">Monitor Functions</a><br />
</ul>


 <span><a name="common-ref"></a><h2 class="title">Common Function Reference</h2><p><p>These common methods allow to manage UI and DM classes component, change
    internal progress meter identifier, speed animation, and many other little tasks.</p>
   <ul><li><a href="../HTML_Progress/tutorial_progress.apiversion.pkg.html">HTML_Progress::apiVersion</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.display.pkg.html">HTML_Progress::display</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.hide.pkg.html">HTML_Progress::hide</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.tohtml.pkg.html">HTML_Progress::toHtml</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.toarray.pkg.html">HTML_Progress::toArray</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.sleep.pkg.html">HTML_Progress::sleep</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setprogresshandler.pkg.html">HTML_Progress::setProgressHandler</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.process.pkg.html">HTML_Progress::process</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.run.pkg.html">HTML_Progress::run</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getui.pkg.html">HTML_Progress::getUI</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setui.pkg.html">HTML_Progress::setUI</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getdm.pkg.html">HTML_Progress::getDM</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setdm.pkg.html">HTML_Progress::setDM</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getident.pkg.html">HTML_Progress::getIdent</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setident.pkg.html">HTML_Progress::setIdent</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getanimspeed.pkg.html">HTML_Progress::getAnimSpeed</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setanimspeed.pkg.html">HTML_Progress::setAnimSpeed</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getstring.pkg.html">HTML_Progress::getString</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setstring.pkg.html">HTML_Progress::setString</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.isstringpainted.pkg.html">HTML_Progress::isStringPainted</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setstringpainted.pkg.html">HTML_Progress::setStringPainted</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.isborderpainted.pkg.html">HTML_Progress::isBorderPainted</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setborderpainted.pkg.html">HTML_Progress::setBorderPainted</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getscript.pkg.html">HTML_Progress::getScript</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getstyle.pkg.html">HTML_Progress::getStyle</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setmodel.pkg.html">HTML_Progress::setModel</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.isindeterminate.pkg.html">HTML_Progress::isIndeterminate</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.setindeterminate.pkg.html">HTML_Progress::setIndeterminate</a></li></ul></p></span>
 <span><a name="error-ref"></a><h2 class="title">Error Handler Reference</h2><p><ul><li><a href="../HTML_Progress/tutorial_progress.raiseerror.pkg.html">HTML_Progress::raiseError</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.haserrors.pkg.html">HTML_Progress::hasErrors</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.geterror.pkg.html">HTML_Progress::getError</a></li></ul></p></span>
 
 <span><a name="observer-ref"></a><h2 class="title">Observer Pattern Reference</h2><p><p>The <i><b>HTML_Progress_Observer</b></i> class provides an implementation 
    of the observer pattern.
    In the content of the HTML_Progress package, it provides a mechanism by which you can 
    examine special event as it is happened. This allows the implementation of special behavior.</p>
   <ul><li><a href="../HTML_Progress/tutorial_progress.addlistener.pkg.html">HTML_Progress::addListener</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.removelistener.pkg.html">HTML_Progress::removeListener</a></li>
    <li><a href="../HTML_Progress/tutorial_progress.getlisteners.pkg.html">HTML_Progress::getListeners</a></li></ul></p></span>

 <span><a name="math-ref"></a><h2 class="title">Mathematical Reference</h2><p><p>Default mathematical model (<i><b>HTML_Progress_DM</b></i> class) handles 
    a common progress bar with a minimum and initial value sets to 0, a maximum set to 100, 
    and an increment set to 1.</p>
   <ul><li><a href="../HTML_Progress/tutorial_dm.getincrement.pkg.html">HTML_Progress::getIncrement</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setincrement.pkg.html">HTML_Progress::setIncrement</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getmaximum.pkg.html">HTML_Progress::getMaximum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setmaximum.pkg.html">HTML_Progress::setMaximum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getminimum.pkg.html">HTML_Progress::getMinimum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setminimum.pkg.html">HTML_Progress::setMinimum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getvalue.pkg.html">HTML_Progress::getValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setvalue.pkg.html">HTML_Progress::setValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.incvalue.pkg.html">HTML_Progress::incValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getpercentcomplete.pkg.html">HTML_Progress::getPercentComplete</a></li></ul></p></span>

 <span><a name="graphic-ref"></a><h2 class="title">Graphical Reference</h2><p><p>The <i><b>HTML_Progress_UI</b></i> class provides methods for
    html code display and element attributes handling.
    You can overload it with HTML_Progress::setUI method.</p>
   <ul><li><a href="../HTML_Progress/tutorial_ui.getorientation.pkg.html">HTML_Progress_UI::getOrientation</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setorientation.pkg.html">HTML_Progress_UI::setOrientation</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getfillway.pkg.html">HTML_Progress_UI::getFillWay</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setfillway.pkg.html">HTML_Progress_UI::setFillWay</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getcellcount.pkg.html">HTML_Progress_UI::getCellCount</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setcellcount.pkg.html">HTML_Progress_UI::setCellCount</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getcellattributes.pkg.html">HTML_Progress_UI::getCellAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setcellattributes.pkg.html">HTML_Progress_UI::setCellAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getcellcoordinates.pkg.html">HTML_Progress_UI::getCellCoordinates</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setcellcoordinates.pkg.html">HTML_Progress_UI::setCellCoordinates</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getborderattributes.pkg.html">HTML_Progress_UI::getBorderAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setborderattributes.pkg.html">HTML_Progress_UI::setBorderAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getstringattributes.pkg.html">HTML_Progress_UI::getStringAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setstringattributes.pkg.html">HTML_Progress_UI::setStringAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getprogressattributes.pkg.html">HTML_Progress_UI::getProgressAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setprogressattributes.pkg.html">HTML_Progress_UI::setProgressAttributes</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getscript.pkg.html">HTML_Progress_UI::getScript</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.setscript.pkg.html">HTML_Progress_UI::setScript</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.getstyle.pkg.html">HTML_Progress_UI::getStyle</a></li>
    <li><a href="../HTML_Progress/tutorial_ui.drawcirclesegments.pkg.html">HTML_Progress_UI::drawCircleSegments</a></li></ul></p></span>

 <span><a name="model-ref"></a><h2 class="title">Data Model</h2><p><p>The <i><b>HTML_Progress_DM</b></i> class 
    handles any mathematical issues arising from assigning faulty values.
    You can overload it with HTML_Progress::setDM method.</p>
   <ul><li><a href="../HTML_Progress/tutorial_dm.getminimum.pkg.html">HTML_Progress_DM::getMinimum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setminimum.pkg.html">HTML_Progress_DM::setMinimum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getmaximum.pkg.html">HTML_Progress_DM::getMaximum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setmaximum.pkg.html">HTML_Progress_DM::setMaximum</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getincrement.pkg.html">HTML_Progress_DM::getIncrement</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setincrement.pkg.html">HTML_Progress_DM::setIncrement</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getvalue.pkg.html">HTML_Progress_DM::getValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.setvalue.pkg.html">HTML_Progress_DM::setValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.incvalue.pkg.html">HTML_Progress_DM::incValue</a></li>
    <li><a href="../HTML_Progress/tutorial_dm.getpercentcomplete.pkg.html">HTML_Progress_DM::getPercentComplete</a></li></ul></p></span>

 <span><a name="constant-ref"></a><h2 class="title">Package HTML_Progress Constants</h2><p><a href="../HTML_Progress/tutorial_progress.constants.pkg.html">All Contants</a> defined in and used by HTML_Progress</p></span>

 <span><a name="monitor-ref"></a><h2 class="title">Monitor Functions</h2><p><p><i><b>HTML_Progress_Monitor</b></i> class allows to execute a process 
    while display a progress bar inside a dialog box.</p>
   <ul><li><a href="../HTML_Progress/tutorial_monitor.notify.pkg.html">HTML_Progress_Monitor::notify</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.setprogresshandler.pkg.html">HTML_Progress_Monitor::setProgressHandler</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.callprogresshandler.pkg.html">HTML_Progress_Monitor::callProgressHandler</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.isstarted.pkg.html">HTML_Progress_Monitor::isStarted</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.iscanceled.pkg.html">HTML_Progress_Monitor::isCanceled</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.run.pkg.html">HTML_Progress_Monitor::run</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.setprogresselement.pkg.html">HTML_Progress_Monitor::setProgressElement</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.getprogresselement.pkg.html">HTML_Progress_Monitor::getProgressElement</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.getstyle.pkg.html">HTML_Progress_Monitor::getStyle</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.getscript.pkg.html">HTML_Progress_Monitor::getScript</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.tohtml.pkg.html">HTML_Progress_Monitor::toHtml</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.accept.pkg.html">HTML_Progress_Monitor::accept</a></li>
    <li><a href="../HTML_Progress/tutorial_monitor.setcaption.pkg.html">HTML_Progress_Monitor::setCaption</a></li></ul></p></span></div>
<table width="100%" border="0" cellpadding="0" cellspacing="0">
<tr>
<td width="33%" align="left" valign="top"><a href="../HTML_Progress/tutorial_part2-monitor.pkg.html">Prev</a></td>
<td width="34%" align="center" valign="top"><a href=
"../HTML_Progress/tutorial_HTML_Progress.pkg.html">Up</a></td>
<td width="33%" align="right" valign="top"><a href=
"../HTML_Progress/tutorial_progress.apiversion.pkg.html">Next</a></td>
</tr>

<tr>
<td width="33%" align="left" valign="top">Monitoring functions v2</td>
<td width="34%" align="center" valign="top">HTML_Progress 1.x</td>
<td width="33%" align="right" valign="top"><span class="function">HTML_Progress::apiVersion</span></td>
</tr>
</table>
        <div class="credit">
		    <hr />
		    Documentation generated on Sun, 12 Sep 2004 20:22:57 +0200 by <a href="http://www.phpdoc.org">phpDocumentor 1.3.0RC3</a>
	      </div>
      </td></tr></table>
    </td>
  </tr>
</table>

</body>
</html>